auto-docs: Update property docs for tag v26.1.10#1745
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThis PR updates Redpanda documentation for the v26.1.10 release. It bumps version metadata in Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs-data/property-overrides.json (1)
843-843:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winRemove literal
+markers fromenable_consumer_group_metricsdescription.The
+characters in this JSON string look like patch artifacts and will render as literal text instead of clean paragraph spacing.Proposed fix
- "description": "List of enabled consumer group metrics. Accepted values include:\n\n- `group`: Enables the xref:reference:public-metrics-reference.adoc#redpanda_kafka_consumer_group_consumers[`redpanda_kafka_consumer_group_consumers`] and xref:reference:public-metrics-reference.adoc#redpanda_kafka_consumer_group_topics[`redpanda_kafka_consumer_group_topics`] metrics.\n- `partition`: Enables the xref:reference:public-metrics-reference.adoc#redpanda_kafka_consumer_group_committed_offset[`redpanda_kafka_consumer_group_committed_offset`] metric.\n- `consumer_lag`: Enables the xref:reference:public-metrics-reference.adoc#redpanda_kafka_consumer_group_lag_max[`redpanda_kafka_consumer_group_lag_max`] and xref:reference:public-metrics-reference.adoc#redpanda_kafka_consumer_group_lag_sum[`redpanda_kafka_consumer_group_lag_sum`] metrics\n+\nEnabling `consumer_lag` may add a small amount of additional processing overhead to the brokers, especially in environments with a high number of consumer groups or partitions.\n+", + "description": "List of enabled consumer group metrics. Accepted values include:\n\n- `group`: Enables the xref:reference:public-metrics-reference.adoc#redpanda_kafka_consumer_group_consumers[`redpanda_kafka_consumer_group_consumers`] and xref:reference:public-metrics-reference.adoc#redpanda_kafka_consumer_group_topics[`redpanda_kafka_consumer_group_topics`] metrics.\n- `partition`: Enables the xref:reference:public-metrics-reference.adoc#redpanda_kafka_consumer_group_committed_offset[`redpanda_kafka_consumer_group_committed_offset`] metric.\n- `consumer_lag`: Enables the xref:reference:public-metrics-reference.adoc#redpanda_kafka_consumer_group_lag_max[`redpanda_kafka_consumer_group_lag_max`] and xref:reference:public-metrics-reference.adoc#redpanda_kafka_consumer_group_lag_sum[`redpanda_kafka_consumer_group_lag_sum`] metrics.\n\nEnabling `consumer_lag` may add a small amount of additional processing overhead to the brokers, especially in environments with a high number of consumer groups or partitions.",As per coding guidelines, property descriptions should use
\n\nfor paragraph breaks rather than inline patch markers.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs-data/property-overrides.json` at line 843, The description string for the property enable_consumer_group_metrics contains stray '+' characters (patch artifacts) that will render literally; remove those '+' markers and replace them with proper paragraph breaks (use "\n\n") so the sentence about additional processing overhead is a separate paragraph, and ensure the final JSON string has no leading/trailing '+' characters and preserves existing newline escapes.Source: Coding guidelines
modules/reference/partials/properties/cluster-properties.adoc (1)
5417-5455:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winClarify the timeout rename/alias.
election_timeout_msandraft_election_timeout_msdescribe the same setting, but the page never says which name is canonical. Please add an alias/forward-reference or remove one entry so readers and downstream tooling don't end up with two authoritative keys for one config.Also applies to: 15148-15195
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@modules/reference/partials/properties/cluster-properties.adoc` around lines 5417 - 5455, This page defines the same property under two names; update the text to state a single canonical name and mark the other as an alias: choose "election_timeout_ms" as the canonical property and add a short clarifying sentence in the election_timeout_ms block like "Alias: raft_election_timeout_ms" (or vice‑versa if you prefer the other as canonical), and remove the duplicate full entry for the aliased name so downstream tools/readers only have one authoritative key; ensure both occurrences (the current block for election_timeout_ms and the other block referencing raft_election_timeout_ms) include the alias wording and identical metadata.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@modules/reference/partials/properties/broker-properties.adoc`:
- Line 2496: The xref targets were normalized incorrectly—update the Antora xref
IDs to include the properties/ segment and full module-prefixed resource IDs:
change any occurrences of reference:cluster-properties.adoc to
reference:properties/cluster-properties.adoc in
modules/reference/partials/properties/broker-properties.adoc (the rack link) and
the corresponding cluster property xrefs in
modules/reference/partials/properties/topic-properties.adoc; ensure each xref
uses the full Antora resource ID with module prefix so links resolve
consistently.
In `@modules/reference/partials/properties/cluster-properties.adoc`:
- Around line 9019-9065: Add the release-provenance marker to the new property
section for iceberg_schema_case_insensitive by inserting the line "*Introduced
in v26.1.10*" under the property title/description (match the style used
elsewhere in the file), and apply the same marker to any other newly added
property sections in this file so all new entries include the release note;
locate sections by the property name iceberg_schema_case_insensitive and any
other recently added property headers to mirror the exact formatting and
placement.
---
Outside diff comments:
In `@docs-data/property-overrides.json`:
- Line 843: The description string for the property
enable_consumer_group_metrics contains stray '+' characters (patch artifacts)
that will render literally; remove those '+' markers and replace them with
proper paragraph breaks (use "\n\n") so the sentence about additional processing
overhead is a separate paragraph, and ensure the final JSON string has no
leading/trailing '+' characters and preserves existing newline escapes.
In `@modules/reference/partials/properties/cluster-properties.adoc`:
- Around line 5417-5455: This page defines the same property under two names;
update the text to state a single canonical name and mark the other as an alias:
choose "election_timeout_ms" as the canonical property and add a short
clarifying sentence in the election_timeout_ms block like "Alias:
raft_election_timeout_ms" (or vice‑versa if you prefer the other as canonical),
and remove the duplicate full entry for the aliased name so downstream
tools/readers only have one authoritative key; ensure both occurrences (the
current block for election_timeout_ms and the other block referencing
raft_election_timeout_ms) include the alias wording and identical metadata.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: eff90727-62bd-4c18-80aa-c7c1e9735180
📒 Files selected for processing (9)
antora.ymldocs-data/property-overrides.jsondocs-data/redpanda-property-changes-v26.1.8-to-v26.1.9.jsondocs-data/redpanda-property-changes-v26.1.9-to-v26.1.10.jsonmodules/reference/attachments/redpanda-properties-v26.1.10.jsonmodules/reference/partials/properties/broker-properties.adocmodules/reference/partials/properties/cluster-properties.adocmodules/reference/partials/properties/object-storage-properties.adocmodules/reference/partials/properties/topic-properties.adoc
💤 Files with no reviewable changes (1)
- docs-data/redpanda-property-changes-v26.1.8-to-v26.1.9.json
| === rack | ||
|
|
||
| A label that identifies a failure zone. Apply the same label to all brokers in the same failure zone. When xref:./cluster-properties.adoc#enable_rack_awareness[enable_rack_awareness] is set to `true` at the cluster level, the system uses the rack labels to spread partition replicas across different failure zones. | ||
| A label that identifies a failure zone. Apply the same label to all brokers in the same failure zone. When xref:reference:properties/cluster-properties.adoc#enable_rack_awareness[enable_rack_awareness] is set to `true` at the cluster level, the system uses the rack labels to spread partition replicas across different failure zones. |
There was a problem hiding this comment.
Normalize the cluster-property xrefs. The edited rack link in modules/reference/partials/properties/broker-properties.adoc and the edited Corresponding cluster property links in modules/reference/partials/properties/topic-properties.adoc now use reference:cluster-properties.adoc, but the canonical docs path here is reference:properties/cluster-properties.adoc. Please keep the properties/ segment so these links resolve consistently; the same typo recurs on the other edited cluster-property xrefs in topic-properties.adoc. As per coding guidelines, use full Antora resource IDs with module prefixes in xref links within property descriptions.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@modules/reference/partials/properties/broker-properties.adoc` at line 2496,
The xref targets were normalized incorrectly—update the Antora xref IDs to
include the properties/ segment and full module-prefixed resource IDs: change
any occurrences of reference:cluster-properties.adoc to
reference:properties/cluster-properties.adoc in
modules/reference/partials/properties/broker-properties.adoc (the rack link) and
the corresponding cluster property xrefs in
modules/reference/partials/properties/topic-properties.adoc; ensure each xref
uses the full Antora resource ID with module prefix so links resolve
consistently.
Source: Coding guidelines
| === iceberg_schema_case_insensitive | ||
|
|
||
| Schema field name comparison mode when matching Redpanda's schema against the one returned by the Iceberg catalog. Some catalogs (e.g. AWS Glue) return field names with inconsistent casing, requiring case-insensitive comparison. "auto" enables case-insensitive comparison when the catalog is AWS Glue, and exact comparison otherwise. | ||
|
|
||
| [cols="1s,2a"] | ||
| |=== | ||
| | Property | Value | ||
|
|
||
| | Type | ||
| | `string` (enum) | ||
|
|
||
| | Accepted values | ||
| | | ||
| ifndef::env-cloud[] | ||
| `auto`, `no`, `yes` | ||
| endif::[] | ||
| ifdef::env-cloud[] | ||
| `auto`, `no`, `yes` | ||
| endif::[] | ||
|
|
||
|
|
||
| | Default | ||
| | | ||
| ifdef::env-cloud[] | ||
| Available in the Redpanda Cloud Console | ||
| endif::[] | ||
| ifndef::env-cloud[] | ||
| `auto` | ||
| endif::[] | ||
|
|
||
| | Nullable | ||
| | No | ||
|
|
||
| | Requires restart | ||
| | Yes | ||
|
|
||
| ifndef::env-cloud[] | ||
| | Restored on xref:manage:whole-cluster-restore.adoc[Whole Cluster Restore] | ||
| | Yes | ||
| endif::[] | ||
|
|
||
| ifndef::env-cloud[] | ||
| | Visibility | ||
| | User | ||
| endif::[] | ||
|
|
||
| |=== |
There was a problem hiding this comment.
Add the v26.1.10 intro marker here.
This new property section is missing the release-provenance note used elsewhere in the catalog. Please add *Introduced in v26.1.10* here, and mirror that marker for the other newly added sections in this file.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@modules/reference/partials/properties/cluster-properties.adoc` around lines
9019 - 9065, Add the release-provenance marker to the new property section for
iceberg_schema_case_insensitive by inserting the line "*Introduced in v26.1.10*"
under the property title/description (match the style used elsewhere in the
file), and apply the same marker to any other newly added property sections in
this file so all new entries include the release note; locate sections by the
property name iceberg_schema_case_insensitive and any other recently added
property headers to mirror the exact formatting and placement.
|
@JakeSCahill I ran source verification and re-ran the generation tool locally to confirm these findings. ```bash Critical issues (tool bugs — need a fix before merge or a follow-up) 1. Broken xrefs in The "Corresponding cluster property" table rows in 2. Wrong xref target for three The same xref change also affects Suggestion 3. Missing "Introduced in v26.1.10" markers
What works well
|
2 participants
This PR auto-generates updated Redpanda property documentation for v26.1.10.